Skip to content

[skip changelog] Add documentation for upload components of the gRPC interface #697

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
May 19, 2020
Merged

[skip changelog] Add documentation for upload components of the gRPC interface #697

merged 1 commit into from
May 19, 2020

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented May 8, 2020

Please check if the PR fulfills these requirements

  • What kind of change does this PR introduce?

Add explanatory comments for the upload components of the gRPC interface to the source code. These comments will be included in the generated gRPC interface documentation.

  • What is the current behavior?

There is insufficient explanation of the gRPC interface in the documentation.

  • What is the new behavior?

Improved documentation of the gRPC interface.

  • Does this PR introduce a breaking change?

No

@per1234 per1234 added topic: documentation Related to documentation for the project component/gRPC labels May 8, 2020
rsora
rsora suggested changes May 12, 2020
View reviewed changes
Copy link
Contributor

@rsora rsora left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's wait for #687 to be merged, then please rebase this PR to get the latest updates on the proto files 👍

@cmaglie
Copy link
Member

cmaglie commented May 15, 2020

We can also do the other way round: merge this one first and resolve the conflicts with #687 directly in #687.

@per1234
[skip changelog] Add documentation for upload components of the gRPC …
6e44e53 
…interface

Comments added to the .proto files are included in the generated gRPC interface documentation.
@per1234
Copy link
Contributor Author

per1234 commented May 17, 2020

I have now rebased on master and added documentation for the newly added import_dir field:

	// Custom path to a directory containing compiled files. When `import_dir` is
	// not specified, the standard build directory under `sketch_path` is used.
	string import_dir = 8;

@per1234 per1234 merged commit 06bc37e into arduino:master May 19, 2020
@per1234 per1234 deleted the upload-grpc-documentation branch May 19, 2020 12:53
@per1234 per1234 self-assigned this Nov 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rsora rsora rsora approved these changes

Assignees

@per1234 per1234

Labels
topic: documentation Related to documentation for the project
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@per1234 @cmaglie @rsora